API

Logistics APIs

GET logistics/shipping-services

List of all shipping services

HTTP method GET
URI https://api.rambase.net/logistics/shipping-services
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2093, version 25

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

Active() Named filter Active shipping services (status 4)
Discontinued() Named filter Clsoed shipping services (status 9)
Imported() Named filter Imported shipping services (status 0)
New() Named filter Shipping services pending registration (status 1)
CarrierId Integer Carrier identifier.
CarrierName String Name of carrier.
CarrierServiceId Integer Shipping service identifier from arhive for shipping services.
ContainingCountryCode String Country code allowing shipping service.
ContainingLocation String Location allowing shipping service.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DepartingWaybillConsolidationTag String All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".
Description String Description of shipping service.
Direction String Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).
ExclusivelyForCustomer Integer Customer identifier.
IsAvailableExternal Boolean True if shipping service should be visibile in external systems. An example of an external system might be a web site..
Name String Name of shipping service.
ShippingServiceId Integer Shipping service identifier.
Status Integer Status of shipping service.

Read more about filters and sorting on how to use sortable parameters

CarrierId Integer Carrier identifier
CarrierName String Name of carrier
CarrierServiceId Integer Shipping service identifier from arhive for shipping services
ContainingCountryCode String Country code allowing shipping service
ContainingLocation String Location allowing shipping service
CreatedAt Datetime Date and time of creation
DepartingWaybillConsolidationTag String All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".
Description String Description of shipping service
Direction String Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).
ExclusivelyForCustomer Integer Customer identifier
IsAvailableExternal Boolean True if shipping service should be visibile in external systems. An example of an external system might be a web site.
Name String Name of shipping service
ShippingServiceId Integer Shipping service identifier
Status Integer Status of shipping service

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ShippingServices>
2
     <ShippingService>
3
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
4
          <Status
Status

Status of shipping service

Possible domain values can be found here

>{Integer}</Status>
5
          <Name
Name

Name of shipping service

>{String}</Name>
6
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
7
          <Description
Description

Description of shipping service

>{String}</Description>
8
          <Direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

>{String}</Direction>
9
          <Carrier>
10
               <CarrierId
CarrierId

Carrier identifier

>{Integer}</CarrierId>
11
               <Name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.Carrier.Name in your request URI to get this field

>{String}</Name>
12
               <CarrierLink
CarrierLink

Carrier reference

>{String}</CarrierLink>
13
          </Carrier>
14
          <CarrierService>
15
               <CarrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

>{Integer}</CarrierServiceId>
16
               <CarriersId
CarriersId

Carrier service identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.CarrierService.CarriersId in your request URI to get this field

>{String}</CarriersId>
17
               <Description
Description

Description of the carriers shipping service

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.CarrierService.Description in your request URI to get this field

>{String}</Description>
18
               <CarrierServiceLink
CarrierServiceLink

Service reference

>{String}</CarrierServiceLink>
19
          </CarrierService>
20
          <ExclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

>
21
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
22
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
23
          </ExclusivelyForCustomer>
24
          <ReturnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

>
25
               <ShippingServiceId
ShippingServiceId

Shipping service identifier

>{Integer}</ShippingServiceId>
26
               <Name
Name

Name of shipping service

>{String}</Name>
27
               <ReturnShippingServiceLink
ReturnShippingServiceLink

Shipping service reference

>{String}</ReturnShippingServiceLink>
28
          </ReturnShippingService>
29
          <ActiveTrackingNumberSeries
ActiveTrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

>
30
               <TrackingNumberSeries
TrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

>
31
                    <TrackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

>{Integer}</TrackingNumberSeriesId>
32
                    <Type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

>{String}</Type>
33
                    <TrackingNumberLink
TrackingNumberLink

Tracking number series reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

>{String}</TrackingNumberLink>
34
               </TrackingNumberSeries>
35
          </ActiveTrackingNumberSeries>
36
          <ShippingServiceLink
ShippingServiceLink

Shipping service reference

>{String}</ShippingServiceLink>
37
     </ShippingService>
38
     <Paging
Paging

Detailed paging information for this list.

>
39
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
40
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
41
          <Page
Page

Page index

>{Integer}</Page>
42
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
43
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
44
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
45
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
46
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
47
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
48
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
49
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
50
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
51
     </Paging>
52
</ShippingServices>
1
{
2
     "shippingServices": [
3
          {
4
               "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
5
               "status
Status

Status of shipping service

Possible domain values can be found here

": "{Integer}",
6
               "name
Name

Name of shipping service

": "{String}",
7
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
8
               "description
Description

Description of shipping service

": "{String}",
9
               "direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Possible domain values can be found here

": "{String}",
10
               "carrier": {
11
                    "carrierId
CarrierId

Carrier identifier

": "{Integer}",
12
                    "name
Name

Name of carrier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.Carrier.Name in your request URI to get this field

": "{String}",
13
                    "carrierLink
CarrierLink

Carrier reference

": "{String}"
14
               },
15
               "carrierService": {
16
                    "carrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

": "{Integer}",
17
                    "carriersId
CarriersId

Carrier service identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.CarrierService.CarriersId in your request URI to get this field

": "{String}",
18
                    "description
Description

Description of the carriers shipping service

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.CarrierService.Description in your request URI to get this field

": "{String}",
19
                    "carrierServiceLink
CarrierServiceLink

Service reference

": "{String}"
20
               },
21
               "exclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

": {
22
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
23
                    "customerLink
CustomerLink

Customer reference

": "{String}"
24
               },
25
               "returnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

": {
26
                    "shippingServiceId
ShippingServiceId

Shipping service identifier

": "{Integer}",
27
                    "name
Name

Name of shipping service

": "{String}",
28
                    "returnShippingServiceLink
ReturnShippingServiceLink

Shipping service reference

": "{String}"
29
               },
30
               "activeTrackingNumberSeries
ActiveTrackingNumberSeries

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

": [
31
                    {
32
                         "trackingNumberSeriesId
TrackingNumberSeriesId

Tracking number series identifier

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

": "{Integer}",
33
                         "type
Type

Tells if this serial of tracking number is to be allocated to each package ("PACKAGE") or for at total shipment ("SHIPMENT")

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

": "{String}",
34
                         "trackingNumberLink
TrackingNumberLink

Tracking number series reference

This field is greyed out because it is an expandable field. You have to add $expand=ShippingService.ActiveTrackingNumberSeries in your request URI to get this field

": "{String}"
35
                    }
36
               ],
37
               "shippingServiceLink
ShippingServiceLink

Shipping service reference

": "{String}"
38
          }
39
     ],
40
     "paging
Paging

Detailed paging information for this list.

": {
41
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
42
          "position
Position

Position of the first element in the list

": "{Integer}",
43
          "page
Page

Page index

": "{Integer}",
44
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
45
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
46
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
47
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
48
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
49
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
50
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
51
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
52
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
53
     }
54
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101119 HTTP 404 Shipping service was not found
Error 101540 HTTP 404 Specified product identifier was not found